Update Local Seller Address

Method: PATCH
/api/v1/local-sellers/{localSellerId}/address/{addressId}

---

Description

This endpoint updates the address details for a specific local seller. It allows updating the address, ESG compliance documents, location details, and other related information for the seller.

---

🔑 Authentication

This endpoint requires authentication via headers.

Param	Value	Type
tenantId	{{tenantId}}	string
userId	{{userId}}	string
countryCode	{{countryCode}}	string (optional)

---

Path Parameters

Name	Type	Description
localSellerId	string	The unique ID of the local seller.
addressId	string	The unique ID of the address to update.

---

Request Body

{
  "docLinks": [
    {
      "name": "SUSTAINABILITY",
      "esgRequirement": "LABOR_PRACTICES",
      "status": "NON_COMPLIANT",
      "link": "string",
      "hasSignOfDeforestation": false,
      "isProtectedArea": false
    }
  ],
  "name": "string",
  "address": "string",
  "country": {
    "name": "string",
    "code": "string",
    "currency": "string"
  },
  "state": {
    "name": "string",
    "code": "string"
  },
  "lga": {
    "name": "string",
    "code": "string"
  },
  "latitude": 0,
  "longitude": 0,
  "location": {
    "type": "string",
    "coordinates": [
      "string"
    ]
  },
  "size": 0
}

Request Body Explanation

Name	Type	Description
docLinks	array	Links to ESG compliance documents.
docLinks[].name	string	The name of the document (e.g., "SUSTAINABILITY").
docLinks[].esgRequirement	string	ESG category (e.g., "LABOR_PRACTICES").
docLinks[].status	string	Compliance status (e.g., "NON_COMPLIANT").
docLinks[].link	string	A URL linking to the document.
docLinks[].hasSignOfDeforestation	boolean	Indicates if deforestation signs were detected.
docLinks[].isProtectedArea	boolean	Indicates if the location is a protected area.
name	string	The name or description of the address (e.g., "Main Warehouse").
address	string	The full physical address.
country	object	Country information (name, code, currency).
state	object	State information (name, code).
lga	object	Local Government Area details (name, code).
latitude	number	Latitude of the address location.
longitude	number	Longitude of the address location.
location	object	GeoJSON-style location information (type and coordinates).
size	number	The size of the location (e.g., farm size in hectares).

Response: 200 OK

{
  "message": "Address updated successfully.",
  "sellerId": "12345",
  "addressId": "67890",
  "updatedAddress": {
    "name": "Main Warehouse",
    "address": "456 Market Street",
    "country": {
      "name": "Nigeria",
      "code": "NG",
      "currency": "NGN"
    },
    "state": {
      "name": "Lagos",
      "code": "LA"
    },
    "lga": {
      "name": "Ikeja",
      "code": "IK"
    },
    "latitude": 6.5244,
    "longitude": 3.3792,
    "size": 15
  }
}